/*
 * The contents of this file are subject to the terms of the Common Development and
 * Distribution License (the License). You may not use this file except in compliance with the
 * License.
 *
 * You can obtain a copy of the License at legal/CDDLv1.0.txt. See the License for the
 * specific language governing permission and limitations under the License.
 *
 * When distributing Covered Software, include this CDDL Header Notice in each file and include
 * the License file at legal/CDDLv1.0.txt. If applicable, add the following below the CDDL
 * Header, with the fields enclosed by brackets [] replaced by your own identifying
 * information: "Portions copyright [year] [name of copyright owner]".
 *
 * Copyright 2015 ForgeRock AS.
 */

package org.forgerock.openam.rest;

import org.forgerock.http.routing.Router;
import org.forgerock.openam.rest.Routers.ServiceRoute;

/**
 * A Router which allows for CHF REST routes to be registered fluently.
 *
 * @since 13.0.0
 */
public interface ServiceRouter {

    /**
     * Starts the fluent route builder.
     *
     * @param uriTemplate The uri template of the route.
     * @return A {@code ResourceRoute}.
     */
    ServiceRoute route(String uriTemplate);

    /**
     * Gets the CHF root router on which all route registration has happened.
     *
     * @return The CHF root router.
     */
    Router getRouter();
}
